docs: improve README overview and organization#48
Conversation
- Restructure opening with clearer value proposition - Move key features to overview section for better discoverability - Reorganize sections with client verification table prominently displayed - Improve quickstart flow and simplify initial setup - Enhance provider setup instructions with better organization
There was a problem hiding this comment.
Pull Request Overview
This PR improves the README.md structure and content to provide clearer value proposition and better organization for the MCP Auth Proxy project. The changes focus on making it easier for users to understand the project's purpose and get started quickly.
- Restructured the README with a new overview section highlighting key features and benefits
- Simplified the quickstart section to reduce initial complexity
- Added a compatibility table for verified MCP clients
- Reorganized configuration and setup sections for better flow
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| 3. Set redirect URI: `{EXTERNAL_URL}/.auth/oidc/callback` | ||
| 4. Note the configuration URL (usually issuer URL + /.well-known/openid-configuration), client ID, and client secret | ||
| 5. Configure the userinfo endpoint to return user identification field (default: email) | ||
| - *1: https://platform.openai.com/docs/mcp |
There was a problem hiding this comment.
[nitpick] The footnote reference should use a standard format. Consider changing '(*1)' to '(1)' for consistency with markdown conventions.
| 3. Set redirect URI: `{EXTERNAL_URL}/.auth/oidc/callback` | ||
| 4. Note the configuration URL (usually issuer URL + /.well-known/openid-configuration), client ID, and client secret | ||
| 5. Configure the userinfo endpoint to return user identification field (default: email) | ||
| - *1: https://platform.openai.com/docs/mcp |
There was a problem hiding this comment.
[nitpick] The footnote reference should use a standard format. Consider changing '(*1)' to '(1)' for consistency with markdown conventions.
| 1. Go to the [Google Cloud Console](https://console.cloud.google.com/) | ||
| 2. Create a new project or select an existing one | ||
| 3. Create OAuth consent screen | ||
| 4. Credentials → Create credentials → OAuth client ID（Web application） |
There was a problem hiding this comment.
The parentheses around 'Web application' use full-width characters (（）) instead of standard ASCII parentheses. This should be changed to '(Web application)' for consistency.
| 4. Credentials → Create credentials → OAuth client ID（Web application） | |
| 4. Credentials → Create credentials → OAuth client ID (Web application) |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Change filesystem path from / to ./ for better security - Fix table formatting in verified MCP clients section - Standardize punctuation in OAuth setup instructions
Summary
Improved the README.md structure and content to provide clearer value proposition and better organization. The changes make it easier for users to understand what MCP Auth Proxy does and how to get started quickly.
Type of Change
Related Issues